kernel: update platform hooks documentation #97099
Open
+77
−27
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The hooks' signature was not visible to Doxygen due to preprocessor conditionals - instead, the dummy no-op implementation was seen instead. Update #ifdef guard to make the hooks' signature and the associated documentation visible to Doxygen such that it appears in docs. Also fix a tiny typo on soc_reset_hook()'s documentation comment. Signed-off-by: Mathieu Choplain <[email protected]>
Document the expected early boot sequence and when platform hooks should be called by the arch-specific coode, and under what conditions. Signed-off-by: Mathieu Choplain <[email protected]>
soc_prep_hook() is always called from z_prep_c() which is implemented as a C function. As such, there is no need to check for the associated CONFIG_SOC_PREP_HOOK since the platform/hooks.h header will define hooks as no-op function-like macros if their associated Kconfig isn't enabled. Remove the Kconfig check from all arch implementations of z_prep_c() and call soc_prep_hook() directly instead, to avoid duplicating the Kconfig check already performed in platform/hooks.h Signed-off-by: Mathieu Choplain <[email protected]>
mathieuchopstm
force-pushed
the
update_hooks_docs
branch
from
11a86f8 to
a4cf927
Compare
|
Rebased + covered |
zephyrbot
added
area: ARC
zephyrbot
requested review from
abrodkin,
evgeniy-paltsev,
fkokosinski,
ithinuel,
JiafeiPan,
kgugala,
MaureenHelm,
npitre,
povergoing,
ruuddw,
SgrrZhf,
stephanosio,
tagunil,
tgorochowik and
wearyzen
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update documentation related to platform hooks: